chore: Flyway 기반 DB 문서 자동 공유 구성#46
Merged
Merged
Conversation
hywznn
added
area:infra
hywznn
commented
Jul 24, 2026
hywznn
marked this pull request as ready for review
July 24, 2026 04:43
23 tasks
krestar
approved these changes
Jul 24, 2026
krestar
left a comment
krestar
left a comment
Contributor
There was a problem hiding this comment.
지금은 머지안되서 링크 안들어가지는데, 구현된다면 확실히 보기 편할 것 같네요
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Refs #45
왜 필요한가요?
Flyway SQL이 DB 구조의 기준이지만 Client·AI·Knowledge·기획 팀원이 테이블과 관계를 확인하려면 SQL과 수동 ERD를 따로 봐야 했습니다.
main의 Migration을 실제 빈 PostgreSQL에 적용한 결과에서 DB용 Swagger 형태의 정적 문서를 자동 생성합니다.무엇이 바뀌나요?
validate합니다.infoJSON을 안전한 Migration 이력 페이지와 build metadata로 변환합니다.database-docs-siteArtifact를 14일간 제공합니다.main에서는 Pages가 성공한 build만https://fowoco.github.io/server/에 배포합니다../scripts/db-docs/generate-local.sh한 명령으로 임시 network·PostgreSQL을 만들고 정확한 임시 자원만 정리합니다.docs/database-documentation.md에 초보자용 사용법을 추가합니다.안전 기준
DB_DOCS_EPHEMERAL=true가 없으면 실행을 거부합니다.검증
node --test scripts/db-docs/generate-site.test.mjsbash -n scripts/db-docs/generate.sh scripts/db-docs/generate-local.shactionlint .github/workflows/ci.yml .github/workflows/database-docs.yml./gradlew clean testgit diff --check로컬 환경에는 Docker가 없어 실제 Flyway·SchemaSpy container 통합은 이 PR의 PostgreSQL GitHub Actions에서 확인합니다. PR 병합 후 Pages 배포와 Wiki 링크를 검증한 다음 #45를 완료 처리합니다.